#***************************************************************************
#                                  _   _ ____  _
#  Project                     ___| | | |  _ \| |
#                             / __| | | | |_) | |
#                            | (__| |_| |  _ <| |___
#                             \___|\___/|_| \_\_____|
#
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at https://curl.se/docs/copyright.html.
#
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
# copies of the Software, and permit persons to whom the Software is
# furnished to do so, under the terms of the COPYING file.
#
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
# KIND, either express or implied.
#
# SPDX-License-Identifier: curl
#
###########################################################################
# 转换 Makefile.inc 文件为 CMake 可识别的文件
# 并获取 'man_MANS' 变量，该变量包含需要生成手册页的文件列表
curl_transform_makefile_inc("Makefile.inc" "${CMAKE_CURRENT_BINARY_DIR}/Makefile.inc.cmake")
# 包含转换后的 Makefile.inc.cmake 文件，以便使用其中定义的变量
include("${CMAKE_CURRENT_BINARY_DIR}/Makefile.inc.cmake")

# 定义一个函数，用于添加生成手册页的自定义命令
# 参数 _listname: 包含需要生成手册页的文件名列表的变量名
function(curl_add_manual_pages _listname)
  # 为避免超出 shell/操作系统的限制，设置每个命令处理的最大文件数
  if(CMAKE_HOST_UNIX)
    # Unix 系统通常限制较小，设置为 10000
    set(_files_per_batch 10000)
  else()  # 例如 Windows 使用 cmd.exe 或其他老旧/未识别的 shell
    # Windows 系统限制相对较小，设置为 200
    set(_files_per_batch 200)
  endif()
  # 初始化已处理的文件计数
  set(_file_count 0)
  # 初始化生成的 roff 格式手册页文件列表
  set(_rofffiles "")
  # 初始化源 Markdown 文件列表
  set(_mdfiles "")
  # 定义一个结束标记，用于在遍历列表结束时触发最后一批文件的处理
  set(_eol "_EOL_")
  # 遍历指定列表中的文件，末尾添加结束标记
  foreach(_file IN LISTS ${_listname} _eol)
    # 增加文件计数
    math(EXPR _file_count "${_file_count} + 1")
    # 当处理的文件数达到上限或遇到结束标记时
    if(_file_count GREATER_EQUAL _files_per_batch OR _file STREQUAL "_EOL_")
      # 添加自定义命令，用于生成 roff 格式的手册页文件
      add_custom_command(OUTPUT ${_rofffiles}
        # 设置命令执行的工作目录为当前源文件目录
        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
        # 执行 Perl 脚本 cd2nroff，将 Markdown 文件转换为 roff 格式
        # -k 参数表示保留中间文件，-d 指定输出目录
        COMMAND "${PERL_EXECUTABLE}" "${PROJECT_SOURCE_DIR}/scripts/cd2nroff" -k -d "${CMAKE_CURRENT_BINARY_DIR}" ${_mdfiles}
        # 该命令依赖于 cd2nroff 脚本和源 Markdown 文件
        DEPENDS "${PROJECT_SOURCE_DIR}/scripts/cd2nroff" ${_mdfiles}
        # 确保命令参数按原样传递
        VERBATIM
      )
      # 重置文件计数
      set(_file_count 0)
      # 清空 roff 文件列表
      set(_rofffiles "")
      # 清空 Markdown 文件列表
      set(_mdfiles "")
    endif()

    # 将生成的 roff 文件路径添加到列表中
    list(APPEND _rofffiles "${CMAKE_CURRENT_BINARY_DIR}/${_file}")
    if(_file STREQUAL "libcurl-symbols.3")
      # 特殊情况，libcurl-symbols.3 是自动生成的文件
      # 将 .3 扩展名替换为 .md，并指定路径为二进制目录
      string(REPLACE ".3" ".md" _mdfile "${CMAKE_CURRENT_BINARY_DIR}/${_file}")
    else()
      # 普通情况，将 .3 扩展名替换为 .md
      string(REPLACE ".3" ".md" _mdfile "${_file}")
    endif()
    # 将源 Markdown 文件路径添加到列表中
    list(APPEND _mdfiles "${_mdfile}")
  endforeach()
  # 移除临时变量
  unset(_rofffiles)
  unset(_mdfiles)
endfunction()

# 添加自定义命令，用于生成 libcurl-symbols.md 文件
add_custom_command(OUTPUT "libcurl-symbols.md"
  # 执行 Perl 脚本 mksymbolsmanpage.pl，处理 symbols-in-versions 文件，生成 libcurl-symbols.md
  COMMAND
    "${PERL_EXECUTABLE}"
    "${CMAKE_CURRENT_SOURCE_DIR}/mksymbolsmanpage.pl" <
    "${CMAKE_CURRENT_SOURCE_DIR}/symbols-in-versions" > "libcurl-symbols.md"
  # 该命令依赖于 mksymbolsmanpage.pl 脚本和 symbols-in-versions 文件
  DEPENDS
    "${CMAKE_CURRENT_SOURCE_DIR}/mksymbolsmanpage.pl"
    "${CMAKE_CURRENT_SOURCE_DIR}/symbols-in-versions"
  # 确保命令参数按原样传递
  VERBATIM
)

# 调用函数，为 man_MANS 列表中的文件添加生成手册页的自定义命令
curl_add_manual_pages(man_MANS)
# 添加自定义目标 curl-man，ALL 表示该目标会在默认构建时执行
# 依赖于 man_MANS 列表中的所有手册页文件
add_custom_target(curl-man ALL DEPENDS ${man_MANS})
# 检查是否禁用安装操作
if(NOT CURL_DISABLE_INSTALL)
  # 初始化安装源文件列表
  set(_src "")
  # 遍历 man_MANS 列表中的每个文件
  foreach(_f IN LISTS man_MANS)
    # 将生成的手册页文件路径添加到安装源文件列表中
    list(APPEND _src "${CMAKE_CURRENT_BINARY_DIR}/${_f}")
  endforeach()
  # 将生成的手册页文件安装到指定的 man3 目录
  install(FILES ${_src} DESTINATION "${CMAKE_INSTALL_MANDIR}/man3")
  # 移除临时变量
  unset(_src)
endif()

# 添加 opts 子目录，CMake 会进入该子目录继续处理其 CMakeLists.txt 文件
add_subdirectory(opts)
